/**
 *  Copyright (c) Filipe Manana <fdmanana@gmail.com>
 *  All rights reserved.
 * 
 *  This file is part of jsdet.
 *
 *  jsdet is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  jsdet is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with jsdet.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


package jsdet.parsing.reporting;

import jsdet.parsing.GlobalParsingStats;
import java.util.*;


/**
 * 
 * @author Filipe Manana
 *
 */
public interface Reporter {

    public static enum ClassesSortOrder {
        ASC("ascending_class_hierarchy_level"),
        DESC("descending_class hierarchy_level"),
        DEFAULT("none"); // default, classes are sorted by the order they were found

        private final String label;

        ClassesSortOrder(String label) {
            this.label = label;
        }

        public String getLabel() {
            return label;
        }
    }

    public String[] getOriginalArgs();

    public void setOriginalArgs(String[] originalArgs);

    public void setReportFunctions(boolean reportFunctions);

    public boolean areFunctionsReported();

    public void setReportClosureObjects(boolean reportClosureObjects);

    public boolean areClosureObjectsReported();

    public void setReportFileNames(boolean reportFileNames);

    public boolean areFileNamesReported();

    public void setReportInheritedMembers(boolean reportInheritedMembers);

    public boolean areInheritedMembersReported();

    public void setClassesToFilter(Set<String> classes);

    public Set<String> getClassesToFilter();

    public void setClassesSortOrder(ClassesSortOrder order);

    public ClassesSortOrder getClassesSortOrder();

    public void setReportNamesOnly(boolean reportNamesOnly);

    public boolean getReportNamesOnly();

    public void reportGlobalParsingStats(GlobalParsingStats stats);
}
